README: Add bindings section
authorColin Walters <walters@verbum.org>
Mon, 22 Oct 2018 14:58:44 +0000 (10:58 -0400)
committerAtomic Bot <atomic-devel@projectatomic.io>
Tue, 23 Oct 2018 13:29:27 +0000 (13:29 +0000)
Since rust-libostree now exists too, let's make sure people
know about it.

Closes: #1762
Approved by: jlebon

README.md

index 36bcfc24f5f8428ff5525adb27191eba37ca0824..6ea343eeb5698349a90b3a99f1efa4cc4f7d0eef 100644 (file)
--- a/README.md
+++ b/README.md
@@ -74,6 +74,22 @@ The [BuildStream](https://gitlab.com/BuildStream/buildstream) build and
 integration tool uses libostree as a caching system to store and share
 built artifacts.
 
+Language bindings
+----
+
+libostree is accessible via [GObject Introspection](https://gi.readthedocs.io/en/latest/);
+any language which has implemented the GI binding model should work.
+For example, Both [pygobject](https://pygobject.readthedocs.io/en/latest/)
+and [gjs](https://gitlab.gnome.org/GNOME/gjs) are known to work
+and further are actually used in libostree's test suite today.
+
+Some bindings take the approach of using GI as a lower level and
+write higher level manual bindings on top; this is more common
+for statically compiled languages.  Here's a list of such bindings:
+
+ - [ostree-go](https://github.com/ostreedev/ostree-go/)
+ - [rust-libostree](https://gitlab.com/fkrull/rust-libostree/)
+
 Building
 --------